home *** CD-ROM | disk | FTP | other *** search
/ Internet File Formats / InternetFileFormatsCD.bin / text / latex / mac / alpha60.hqx / Help / Alpha Commands next >
Encoding:
Text File  |  1995-07-01  |  32.5 KB  |  637 lines

  1. ==============================================================================
  2. = Alpha Commands
  3. ==============================================================================
  4.  
  5. In this list of routines, text between '<' and '>' is a placeholder for a 
  6. required parameter, text between '[' and ']' is a placeholder for an 
  7. optional parameter, and the '|' signifies a choice of two or more 
  8. alternatives.  A '+' signifies that the previous symbol can be present one 
  9. or more times, while a '*" means zero or more times.  Some commands have no 
  10. parameters, and are only expected to be called interactively.
  11.  
  12.  
  13.  
  14. The following are Alpha-specific tcl routines:
  15.  
  16. Ñ abortEm - aborts whatever is currently happening
  17. Ñ addMenuItem [-m] [-l <meta-characters>] <menu name> <item name> - Convert
  18.   item to menu form and add to specified menu. If '-m' specified, menu 
  19.   form conversion not done. The '-l' option allows you to use menu meta 
  20.   characters as text of menu items. If the '-l' option is used, the 
  21.   <meta-characters> string is interpreted for menu item attributes, and 
  22.   meta-characters in <item name> are included in the menu item text 
  23.   literally. For example: 
  24.       addMenuItem -m -l "/B" "Hello/C" 
  25.   would appear as the text "Hello/C" in the menu, and have "B" as its 
  26.   command equivalent.
  27. Ñ addDef <var> <val> - Permanently save an association between the var 
  28.   'var' and 'val'. 'addDef' and 'addArrDef' are now the sanctioned way to 
  29.   save values between sessions. Also see 'removeDef' and 'removeArrDef'.
  30. Ñ addArrDef <var> <field> <val> - Permanently save an association between 
  31.   the var var(field) and 'val'.
  32. Ñ AEBuild [<flags>] <app (name|creator)> <aesuite> <aeevent> [<event parameters>]*  -
  33.   Build and send an apple-event. 'AEBuild' is apple's code of the same 
  34.   name. Each "event parameter" is two parameters, a parameter type and 
  35.   the data for the parameter. See the AEBuild doc for more details, 
  36.   :Tcl:SystemCode:think.tcl for examples. The flags are '-r' (wait for reply), 
  37.   '-q' (queue reply, in which case 'handleReply' (in appleEvents.tcl) is 
  38.   called with the reply as a parameter, and '-t <timeout>' specifies the 
  39.   timeout in ticks.
  40. Ñ alertnote message_string
  41.   This command will display message_string in a standard Macintosh alert box.
  42. Ñ alphaHelp - display Alpha help.
  43. Ñ ascii (see bindings).
  44. Ñ askyesno [-c] prompt
  45.   This command will display a Macintosh alert box with 'prompt' displayed
  46.   with the push buttons Yes and No. The command will return the 
  47.   string "yes" or "no". The '-c' flag specifies that a cancel button be 
  48.   used as well.
  49. Ñ backColor - set background color
  50. Ñ backSpace - delete selection, or a single char if no selection.
  51. Ñ backwardChar - moves insertion one char back
  52. Ñ backwardCharSelect - extends selection one char back
  53. Ñ backwardDeleteWord - deletes previous word
  54. Ñ backwardWord - moves insertion one char back
  55. Ñ balance - selects smallest set of parens, braces, or 
  56.   brackets that encloses the current selection
  57. Ñ beep
  58. Ñ beginningBufferSelect - extend selection to the 
  59.   beginning of the buffer
  60. Ñ beginningLineSelect - extend selection to the 
  61.   beginning of the line
  62. Ñ beginningOfBuffer - move insertion to the beginning 
  63.   of the buffer
  64. Ñ beginningOfLine - move insertion to the beginning of 
  65.   the line
  66. Ñ bind  (see bindings)
  67. Ñ blink <pos> - blink cursor at 'pos'
  68. Ñ breakIntoLines <string> - return 'string' with 
  69.   carriage returns and spaces inserted to satisfy 
  70.   'leftFillColumn' and 'fillColumn' variables.
  71. Ñ bringToFront <winName> - Bring named window to front.
  72. Ñ buttonAlert <prompt> [<button>╔] - Create a dialog w/ the specified 
  73.   buttons, returning the one selected.
  74. Ñ capitalizeRegion - capitalize all words in selected 
  75.   region 
  76. Ñ capitalizeWord - capitalize word
  77. Ñ cd [directory]
  78.   This command will set the current working directory to "directory". The directory 
  79.   argument may or may not end with a colon. The working directory is the directory 
  80.   in which file names that contain no colons (folders) will be located with file related 
  81.   commands. No argument means Alpha's home directory.
  82. Ñ centerRedraw - redraw window with current line in 
  83.   the middle.
  84. Ñ clear - clear selected text
  85. Ñ closeAll - close all windows
  86. Ñ colors <fore red> <fore green> <fore blue> <back red> <back green> <back blue>
  87. Ñ copy - copy region
  88. Ñ cp <fromName>+ <toName>
  89.   This command will copy the file fromName and name the new file toName, 
  90.   overwriting any existing file. This command copies both data forks, and 
  91.   the Finder information. 
  92. Ñ createTagFile - searches all files in current file set 
  93.   and saves the locations of any function declarations
  94.   in a file called 'cTAGS'.
  95. Ñ createTMark <name> <pos> - create a temporary 'mark' 
  96.   at location 'pos'. 
  97. Ñ currentPosition - displays current and total bytes.
  98. Ñ cut - deletes and saves region
  99. Ñ deleteChar - delete char AFTER cursor
  100. Ñ deleteMenuItem [-m] <menu name> <item name> - Convert item to menu form 
  101.   and delete from specified menu. If '-m' specified, menu form conversion 
  102.   not done. 
  103. Ñ deleteModeBindings <mode> - Delete all bindings for specified mode.
  104. Ñ deleteSelection - delete current position, don't save
  105. Ñ deleteWord - delete word after cursor
  106. Ñ describeBinding - display the binding of the next typed key sequence. 
  107. Ñ deleteText <pos1> <pos2> - remove text between 'pos1' 
  108.   and 'pos2'
  109. Ñ display [-w <win>] <pos> - move pos's line to top of screen.
  110. Ñ displayMode <mode> - Up to four characters of the 'mode' string are 
  111.   displayed in the status line at the bottom of a window.
  112. Ñ dosc [<-c 'sign' | -n appName>] [-k 'clas'] [-e 'evnt'] <-s string | -f fileName> [<-t timeout|-r>]
  113.   Send an AppleEvent, by default class 'misc', event 'dosc'.
  114.    -c 'sign' 
  115.            "sign" is a four-letter creator signature of a running application.
  116.    -n appName
  117.            "appName" is the name of a running application.
  118.    -k 'clas'
  119.            "clas" is a four-letter event class.
  120.    -e 'evnt'
  121.            "evnt" is a four-letter event class.
  122.    -s string
  123.            "string" is the text of a script to send to the other app.
  124.    -f fileName
  125.            "fileName" is the complete or relative pathname of a file the other 
  126.            application should execute.
  127.    -t timeout
  128.            "timeout" is the number of ticks Alpha should wait for a response. A 
  129.            timeout of "0" means wait forever.
  130.    -r
  131.            Do not wait for reply.
  132.    -q
  133.            Queue reply.
  134.            
  135.    If neither of the '-c' and '-n' options is chosen, the PPC Browser is 
  136.    used. Either '-s' or '-f' must be chosen. Thus, you can have "Alpha 
  137.    5.02" and "Alpha 5.02 Copy" sending Apple events to each other, or they 
  138.    can send events to a remote server such as Apple's ToolServer. 
  139.    "$HOME:Tcl:UserCode:createStuffitArchive.tcl" contains examples of 
  140.    controlling Stuffit Deluxe via this command.
  141. Ñ downcaseRegion - changes all uppercase letters to 
  142.   lowercase in current region
  143. Ñ downcaseWord - changes all uppercase letters to 
  144.   lowercase in current word
  145. Ñ dumpColors - dump current foreground and background
  146.   colors into the current buffer in Alpha-readable
  147.   format.
  148. Ñ dumpMacro - prompts for a name and then dumps a tcl proc representation 
  149.   of the current keyboard macro into the current window.
  150. Ñ echo <string>* - echo the strings (used 
  151.   in shells).
  152. Ñ edit <name> [-r] [-m] [-w] [-g <t> <t> <w> <h>] - Open a file in a new window. 
  153.   '-r' means open the file read-only. '-m' means omit the function titlebar 
  154.   menu and present only the marks titlebar menu, which is labeled with the 
  155.   contents of 'markLabel'. The '-g' option allows left and top coords to 
  156.   be specified, plus width, and height. All or none. '-w' allows you to
  157.   bypass the "Wrap" dialog for files with long rows.
  158. Ñ enableMenuItem <menuName> <item text> <on|off> - Either enable or 
  159.   disable the menu item of user menu 'menuName' that has text '<item 
  160.   text>'. Note that unless the menu is not only created, but also already
  161.   inserted, this command has no effect. 
  162. Ñ endBufferSelect - extend selection to the end of the 
  163.   buffer
  164. Ñ endKeyboardMacro - stop recording keyboard macro
  165. Ñ endLineSelect - extend selection to the end of line
  166. Ñ endOfBuffer - move insertion to the end of the buffer
  167. Ñ endOfLine - move insertion to the end of the line
  168. Ñ enterSelection - use current selection for future searches.
  169. Ñ exchangePointAndmark - exchange the current 'mark' 
  170.   w/ the current insertion point
  171. Ñ execute - prompt user for a function or macro. The 
  172.   tab key acts as a "completion" command.
  173. Ñ executeKeyboardMacro - execute the current keyboard 
  174.   macro
  175. Ñ fileInfo - prompts for a file, and displays type, 
  176.   creator, sizes of both data and resource forks, last
  177.   modification time, and creation time
  178. Ñ fileRemove - prompts for a file, and removes it
  179. Ñ find - bring up the find dialog
  180. Ñ findFile - open a file in a new window
  181. Ñ findInNextFile - search next file.
  182. Ñ findTag - prompt user for a function name and attempt 
  183.   to use the file 'cTAGS' to locate the function's 
  184.   definition
  185. Ñ foreColor - set foreground (text) color
  186. Ñ forwardChar - move insertion one character forward
  187. Ñ forwardCharSelect - extend selection one character 
  188.   forward
  189. Ñ forwardWord - move insertion one word forward
  190. Ñ freeMem - give a rough approximation of the current 
  191.   memory reserves of ALPHA
  192. Ñ get_directory [-p <prompt>]
  193.   This command will display a standard Macintosh file dialog and request the user 
  194.   select a folder. The command will return the selected folder's full path name, or an 
  195.   empty string if the Cancel button was selected.
  196. Ñ getAscii - displays the ASCII code for character at 
  197.   current insertion point
  198. Ñ getChar - waits for a keystroke, returns ascii.
  199. Ñ getColors - returns list of colors/hypertext for current document. 
  200.   Format is list of lists, each sublist consisting of file offset, color 
  201.   index, and possibly a hypertext command.
  202. Ñ getfile <prompt>
  203.   This command will display an SFGetFile() and return the full path name of the 
  204.   selected file, or an empty string if CANCEL button was selected.
  205. Ñ getFileInfo <file> <arr> - Given a file name, creates an array called 
  206.   'arr' in the current context, containing fields 'created', 'creator', 
  207.   'modified', 'type', 'datalen', and 'resourcelen'. 'created' and 
  208.   'modified' are in a form suitable for the command 'mtime'.
  209. Ñ getGeometry [win] - return a TCL list containing the left 
  210.   edge of the current window, the top, the width, and height.
  211. Ñ getline <prompt> <default>
  212.   This command will display a Macintosh alert box with prompt displayed, a 
  213.   text edit field with default initially in the field, and with the push 
  214.   buttons OK, Cancel.. The command will return the text entered into the 
  215.   text edit field by the user, or an empty string if the user selected the 
  216.   Cancel button. 
  217. Ñ getMainDevice - return a list containing the left, top, right, and 
  218.   bottom of the rectangle defining the main device.
  219. Ñ getMark - return the current mark.
  220. Ñ getNamedMarks [-w <win>] [-n] - 
  221.   return list of all permanent marks in open files. Each
  222.   element of a list describes one mark as a sublist of the mark's name, 
  223.   the complete pathname of the mark's file, the position of the first 
  224.   character in the first line displayed, the current position, and the 
  225.   end of the selection if text is hilited, or the current position again 
  226.   if there is no hilited section. '-w' allows window name to be applied 
  227.   as filter, '-n' means only names will be returned.
  228. Ñ getPathName - prompt the user with an SFGetFile dialog and return 
  229.   complete pathname.
  230. Ñ getPos [-w <win>] - return the current insertion point
  231. Ñ getScrap - returns system TEXT scrap.
  232. Ñ getSelect - return the currently selected text, if 
  233.   any.
  234. Ñ getText [-w <win>] <pos1> <pos2> - return the text between 'pos1' 
  235.   and 'pos2'. '-w' can be used to specify a window.
  236. Ñ getTMarks - Return a list of temporary marks. Each item of the returned 
  237.   list is a sublist containing the mark name, the complete pathname of the 
  238.   mark, and the start and finish of the selection named by the mark. The 
  239.   following is an example of the result: 
  240.  
  241.     {{temp1 External:file.c 1312 1315} {temp2 Internal:it.h 111 111}} 
  242.  
  243. Ñ getWinInfo [-w <win>] <arr> - Creates an array in current context 
  244.   containing info about either the current or a specified window. Array 
  245.   has fields 'state', 'platform', 'read-only', 'tabsize', 'split', 
  246.   'linesdisp' (num lines that can be seen in the window) and 'dirty'.
  247. Ñ glob [-i] [-t <TYPE>] [-c <CRTR>]
  248.   The original glob provided by the UNIX version of tcl was not quite 
  249.   adequate for the more complex Macintosh file system. Issues such as 
  250.   invisible file handling, Finder type and creator filtering, and space 
  251.   handling in file names. Release 6 of tcl has dealt with the original 
  252.   problem with spaces in filenames, but the following options are provided 
  253.   to deal with additional Macintosh issues. 
  254.  
  255. Anyway, the new glob now takes several options. They are:
  256.     -i    This option causes glob to list invisible files also.
  257.     -t TYPE    This option causes glob to only list file with the 
  258.         indicated Finder file typeTYPE. This option may be 
  259.         used with the -c option.
  260.     -c CRTR    This option causes glob to only list file with the 
  261.         indicated Finder file creatorCRTR. This option may 
  262.         be used with the -t option.
  263.         Also note that the original glob would skip dot files
  264.         (i.e., file names the begin with a period) 
  265.         in the listing, unless the pattern began with a period.
  266.         Tickle extends this concept one step further on the
  267.         Macintosh, and skips spot files (i.e., file names that 
  268.         begin with 'Ñ'), unless the pattern starts with a spot.
  269. Ñ goto <pos> - goto the position 'pos'.
  270. Ñ gotoMark - goto named mark, use 'mark' in macros.
  271. Ñ gotoTMark <name> - goto the temporary mark 'name'.
  272. Ñ icon [-f <winName>] [-c|-o|-t|-q] [-g <h> <v>] - Having to do w/ 
  273.   iconifying windows. '-c' means close (iconify) window, '-o' open, '-t' 
  274.   toggle open/close, '-q' returns either a '1' for an iconified window or a 
  275.   '0' for an uniconified window, and '-g' moves the icon to horizontal 
  276.   position <h> and vertical position 'v'. Options are executed as they 
  277.   are parsed, so the '-f' option, if present, should always be first. 
  278. Ñ insertAscii - prompts for an ASCII code and inserts
  279.   into text.
  280. Ñ insertColorEscape <pos> <color ind> [hypertext func] - Create a color 
  281.   or style "point" for documentation purposes. Look at the file 
  282.   "docColors.tcl" for examples. The hypertext func is only used when the 
  283.   "point" is underline. See 'getColors' for info about the current file.
  284. Ñ insertFile - prompts for a file name and inserts the
  285.   corresponding file into the current window. Not
  286.   undoable.
  287. Ñ insertMenu <name> - insert the previously created user menu 'name' into 
  288.   the menuBar. 
  289. Ñ insertPathName - present the user w/ a SFGetFIle dialog 
  290.   and paste the complete path-name of the chosen file
  291.   into the current window
  292. Ñ insertText [-w <win name>] <text>* - Insert 'text' at the current 
  293.   insertion point.
  294. Ñ insertToTop - make the line that the insertion point 
  295.   is on the first line shown, and display the current 
  296.   line number along w/ the total number of lines in file
  297. Ñ isearch - incremental search: searches w/o a dialog,
  298.   searches as you type the search pattern. Does not do
  299.   regular expression searches. 'matchWords' 
  300.   automatically set to false.
  301. Ñ iterationCount - allows actions to be repeated many times. "control-u 44 
  302.   =" inserts 44 '='s into current window.  Also can be used to execute any 
  303.   function or macro (including the keyboard macro) many times.  Defaults to 
  304.   4.
  305. Ñ jumpToRegister - prompts for a single char, and then jumpts to 
  306.   temporary mark of that name created by 'pointToRegister'.
  307. Ñ keyAscii - insert ascii representation (in decimal)
  308.   of the keydown event, plus a modifier string, if 
  309.   necessary.
  310. Ñ keyCode - insert the key code along w/ a string 
  311.   representing and modifiers into the current window.
  312.   Can be used to create bindings in 'Alphabits'.
  313. Ñ killLine - kill text from insertion point to the end 
  314.   of the line. If the line has no text, delete the line 
  315.   and move succeeding lines up one.
  316. Ñ killWindow - kill current window
  317. Ñ largestPrefix <list> - Returns the longest prefix contained in all 
  318.   strings of 'list'.
  319. Ñ launch -f <name> - launch the named app into the background. Note that 
  320.   for some yet unexplained reason, some applications (MicroSoft Word) 
  321.   won't launch completely in the background. 'launch'ing such 
  322.   applications won't insert the application into any system menu that 
  323.   specifies running applications (although "About the Finder..." will 
  324.   list it. The only way to get to such an app is through Alpha's 
  325.   'switchTo', after which the application will finish launching. The '-f' 
  326.   option gets around this by launching the application in the foreground 
  327.   instead.
  328. Ñ lineStart <pos> - return the position of the start of
  329.   the line 'pos' is on.
  330. Ñ listBindings - list all current bindings.
  331. Ñ listpick [-p <prompt>] [-l] [-L <def list>] <list>
  332.   This command will display a dialog with the list displayed in a List Manager list. If 
  333.   the user presses the Cancel button, an empty string is returned. If the user selects 
  334.   the Open button, or double clicks an item in the list, that item will 
  335.   be returned. If '-l' is specified, than the return is a list of items.
  336. Ñ load - loads hilited text, or entire window if 
  337.   nothing is hilited. 'load'ing means that whatever 
  338.   bindings or macro definitions are present in the 
  339.   loaded text take effect
  340. Ñ lookAt [-w <name>] <pos> - return the 'pos'th character of the 
  341.   current file, or the file named by <name> if the '-w' option is specified.
  342. Ñ markHilite - This is the 'Hilite' from the 'Edit'
  343.   menu. If there is a currently hilited selection, the 
  344.   selection is unhilited, leaving the mark and the 
  345.   insertion point around the old selection. If there 
  346.   is not a selection, the region between the insertion 
  347.   point and the mark is selected.
  348. Ñ markMenuItem [-m] <menuName> <item text> <on|off> [<mark char>] - Either mark or unmark
  349.   the menu item of user menu 'menuName' that has text '<item text>'. 
  350.   Note that unless the menu is not only created, but also already
  351.   inserted, this command has no effect. 
  352. Ñ matchBrace - moves the insertion point to the 
  353.   character that matches the character after the current 
  354.   insertion point
  355. Ñ matchIt <brace char> <pos> - Return pos of matching brace. Recognizes 
  356.   parenthesis, square brackets, and curly braces.
  357. Ñ maxPos [-w <win>] - returns the number of characters in the front
  358.   window.
  359. Ñ menu [-n <name>] [-i <num] [-m] [-M <mode>] [-p <procname>] <list of menu items> - 
  360.   Defines a new menu named 'name' (if provided w/ '-n' option). The menu is not 
  361.   yet inserted into the menubar. The menu commands may be nested for 
  362.   heirarchical menus, see 'AlphaBits.tcl' for examples. Alpha massages the 
  363.   function names to make them look better in the menus. 
  364.   '-s'            Use system menu definition proc (faster).
  365.   '-n <num>'    Resource id of icon suite to use for menu title. 'ics#' 
  366.                 is the only resource that is really necessary.
  367.   '-n <name>'    Name the menu. Not necessary for submenus.
  368.   '-m'            No menu form. If not supplied, each menu item is split into 
  369.                   words at each capitalized letter.
  370.   '-p <name>'     The tcl proc named by 'name' is called w/ the menu item's 
  371.                   contents as it's single argument when the item is chosen. If the 
  372.                   proc returns "normal" as its result, the menu item is executed as 
  373.                   if no proc had been specified.
  374.   '-M <mode>'    Specifies that any bindings created by the menu are 
  375.                   specific to a given mode. This is important because mode-specific
  376.                   bindings over-ride global bindings.
  377. Ñ message <string> - prints 'string' on the status line.
  378. Ñ mkdir <name> - creates a directory (folder) named 
  379.   'name' in the current directory.
  380. Ñ mousePos - Returns list <row,col> of mouse position, if the mouse is 
  381.   currently over the active window. Otherwise, return error (catch w/ 
  382.   'catch').
  383. Ñ moveInsertionHere [-last] - move the insertion point to the 
  384.   first (or last) line displayed
  385. Ñ moveFile <fromName> <toName>
  386.   This command will move the file fromName to toName, overwriting any 
  387.   existing file. The move can not be made across volume (disk drives) 
  388.   boundaries. 
  389. Ñ moveWin [win name] <left> <top> - moves current or specified window. 
  390.   The window name can be "StatusWin".
  391. Ñ mtime <time> [long|short|abbrev]
  392.   Returns a date and time string using the Macintosh International Utilities. The 
  393.   long/short/abbrev specification corresponds to the date. These are the following 
  394.   formats:
  395.     short        3/16/92 9:20:46 PM
  396.     abbrev    Mon, Mar 16, 1992 9:20:49 PM
  397.     long        Monday, March 16, 1992 9:20:43 PM
  398.   The returned value actually is in the form of a list. To get text as 
  399.   above, run the result through 'join', as in "join [mtime [now] short]".
  400. Ñ new [-g <l> <t> <w> <h>] [-n <name>] - opens an untitled window. Can optionally 
  401.   provide left and top coordinates, plus width and height. All or none.
  402. Ñ nextLine - move insertion point to next line
  403. Ñ nextLineSelect - extend selection to the next line
  404. Ñ nextLineStart <pos> - return the position of the start 
  405.   of the next line after position 'pos'.
  406. Ñ nextSentence - go to next sentence ("fill.tcl").
  407. Ñ nextWindow - select next window
  408. Ñ now
  409.   Returns the current time as Macintosh seconds. This is the number of seconds that 
  410.   have elapsed since Midnight Jan 1, 1904.
  411. Ñ oneSpace - converts whitespace surrounding insertion
  412.   into a single space.
  413. Ñ openLine - insert a new line following the current 
  414.   one and move the insertion point to it
  415. Ñ otherPane - If window is split, select the other pane.
  416. Ñ pageBack - display prev screenful, move the
  417.   insertion point if 'moveInsertion' enabled
  418. Ñ pageForward - display next screenful, move the
  419.   insertion point if 'moveInsertion' enabled
  420. Ñ pageSetup - display the printing PageSetup dialog.
  421. Ñ paste - insert the last chunk of text created by 'cut' 
  422.   or 'copy'
  423. Ñ pointToRegister - prompts for a single character, and then assigns a 
  424.   temporary mark of that name to the current insertion point. Point can 
  425.   be jumped to via 'jumpToRegister'.
  426. Ñ posToRowCol <pos> - converts from absolute position to row, col.
  427. Ñ prefixChar - used to further modify the next keystroke 
  428.   combination, in the same manner as using the shift key 
  429.   in the next keystroke
  430. Ñ previousLine - move insertion point to the previous 
  431.   line
  432. Ñ prevLineSelect - extend selection to the previous line
  433. Ñ prevSentence - go to previous sentence ("fill.tcl").
  434. Ñ prevWindow - select previous window
  435. Ñ print - print front window
  436. Ñ processes - returns info of active processes. A list of lists, each 
  437.   sublist contain a file-name, an application signature, the application 
  438.   memory size, and the number of ticks the application has been active.
  439. Ñ prompt <prompt> <default> [<name> <menu item>*] - prompt dialog to 
  440.   the user with a prompt string and a default value. The prompt dialog can 
  441.   optionally include a popup menu specified by 'name' and the succeeding 
  442.   strings. Selection of the popup menu items inserts the item text into the 
  443.   editable dialog item. 'Prompt' returns the value of the editable item. 
  444.   If the 'Cancel' button is selected, the tcl returns an error and your 
  445.   script will be stopped unless you execute the command from 'catch'.
  446. Ñ putfile <prompt> <original>
  447.   This command will display an SFPutFile() and return the full path name of the 
  448.   selected file, or an empty string if CANCEL button was selected. Original is the 
  449.   default name displayed for the user.
  450. Ñ putScrap [<string>]+ - Concatenate strings together into the system 
  451.   scrap. The scrap can be appended to through calls of the form 'putScrap 
  452.   [getScrap] " another word"'.
  453. Ñ pwd
  454.   This command will return the current working directory, ending in a colon.
  455. Ñ quit - quits ALPHA
  456. Ñ rectMarkHilite - creates a rectangular selection 
  457.   between the mark and the insertion point.
  458. Ñ redo - redo the next action that has been undone but 
  459.   not redone
  460. Ñ regModeKeywords [options] <mode> <keyword list> - Set keywords and comments that 
  461.   Alpha can recognize to color them. Specifically, in mode <mode>, every 
  462.   keyword specified in the list is colored non-black (blue, by default). 
  463.   Comments, if specified by '-e' or '-b' below, are colored red by defualt.
  464.     -a                                Keywords will be *added* to existing mode
  465.                                     keywords. The new keywords can be a different
  466.                                     color than older keywords.
  467.     -m <c>                            Specify a magic character. Every word beginning with the 
  468.                                     magic character is a keyword.
  469.     -e <commentstr>                    Specify a string that begins comments that last to 
  470.                                     the end of the line. 
  471.     -b <comment beg> <comment end>    Specify a pair of strings that bracket a 
  472.                                     comment.
  473.     -c <color>                        Comment color.
  474.     -k <color>                        Keyword color.
  475.     -i <char>                        Specify a character to display differently.
  476.                                     Commonly used for curly braces, etc.
  477.     -I <color>                        Color of above characters.
  478.     Keywords must be less than 20 characters long.
  479. Ñ removeArrDef <var> <field> - Remove the pernament definition of 
  480.  'var(field)'. See 'addDef' and 'addArrDef'.
  481. Ñ removeDef <var> - Remove the permanent definition of 'var'.
  482. Ñ removeFile <fileName>
  483.   This command will delete the file or folder 'fileName'.
  484. Ñ removeMark [-all]|[[-n <mark name] [-w <specname>]]- allows marks to be 
  485.   removed. If no options are specified, it's interactive.
  486. Ñ removeMenu <name> - remove menu 'name' from menubar, except those 
  487.   specified by previous 'makeMenuPermanent' calls.
  488. Ñ removeTMark <name> - remove temporary mark.
  489. Ñ repeatSearchBackward - repeat search backward
  490. Ñ repeatSearchForward - repeat search forward
  491. Ñ replace - replace the current selection
  492. Ñ replaceAll - replace all further occurrences in the current file.
  493. Ñ replace&FindAgain - replace the current selection and find next 
  494.   occurrence.
  495. Ñ replaceString <str> - specifies replacement string
  496. Ñ replaceText <pos1> <pos2> [text]+ - replaces the text
  497.   between 'pos1' and 'pos2' with 'text', where 'text' can be any number 
  498.   of arguments. Leaves insertion at end, mark at beginning of inserted 
  499.   text. 
  500. Ñ restoreVars - restore variables to saved state, 
  501.   see 'saveVars'
  502. Ñ revert - revert the file to it's last saved version
  503. Ñ rowColToPos [-w <win>] <row> <col> - converts to abosolute position.
  504.   Accepts optional -w parameter that allows window to be specified.
  505. Ñ rsearch - reverse incremental search, see 'isearch'.
  506. Ñ save - save current window
  507. Ñ saveAs [def name] - save current window with new name. Optionally takes 
  508.   a default filename. Returns complete path of saved file, if ok hit, 
  509.   otherwise TCL_ERROR returned.
  510. Ñ saveVars - save variable state, see 'restoreVars'
  511. Ñ scrollDownLine - same action as that which occurs when 
  512.   the down arrow in the vertical scrollbar is selected
  513. Ñ scrollLeftCol - same action as that which occurs when
  514.   the left arrow in the horizontal scrollbar is selected
  515. Ñ scrollRightCol - same action as that which occurs when
  516.   the right arrow in the horizontal scrollbar is 
  517.   selected
  518. Ñ scrollUpLine - same action as that which occurs when 
  519.   the up arrow in the vertical scrollbar is selected
  520. Ñ search  [options╔] <pattern> <pos> - 
  521.   -f <num>        - go forward?
  522.   -r <num>        - regular expression?
  523.   -s            - save previous search string and search flags.
  524.   -i <num>        - ignore case?
  525.   -m <num>        - match words?
  526.   -n            - failed search still returns TCL_OK, but null string.
  527.   -l <limit>    - limit on how search goes.
  528.   --             - next arg is the pattern.
  529.  
  530.   Searches for 'pattern' from position 'pos'.  If the search succeeds, a 
  531.   list of two positions will be returned.  The first is the starting position 
  532.   of the match, the second is one past the last character. If no '-n', 
  533.   TCL_ERROR returned.
  534. Ñ select <pos1> <pos2> - selects the text between 'pos1' 
  535.   and 'pos2'.
  536. Ñ selEnd [-w <win] - returns the end of the hilited selection, or 
  537.   the current insertion point if no text is selected.
  538. Ñ sendOpenEvent [filler] <app name> <file name> - Send an open doc event to 
  539.   another currently running application. If 'filler' is noReply, then a 
  540.   reply is not requested. Otherwise, we wait for a reply and 'filler' is 
  541.   ignored. 
  542. Ñ sendToBack <winName> - Sent named window to back.
  543. Ñ setFileInfo <file> <field> [arg] - Allows some information to be set 
  544.   for files. Settable fields are 'modified', 'created', 'creator', and 
  545.   'type' all take an argument. 'resourcelen' can be set, but doesn't take 
  546.   an argument and just removes the resource fork.
  547. Ñ setFontsTabs - bring up font and tab dialog
  548. Ñ setMark - set the current mark to the insertion point
  549. Ñ setNamedMark [name disp pos end] - set named mark. If optional arguments are 
  550.   present, the mark is created with prompting user. 'disp' is the 
  551.   character position of the start of the first line to be displayed, 
  552.   while 'pos' and 'end' bracket the text to be selected.
  553.   the first char 
  554. Ñ setWinInfo [-w <win>] <field> <arg> - Sets a piece of data about either 
  555.   the current or a specified window. Settable fields 'platform', 'state', 
  556.   'read-only', 'tabsize' and 'dirty'.
  557. Ñ shell - open the Tcl shell.
  558. Ñ shiftLeftRegion - shifts the current region left a tab
  559. Ñ shiftRightRegion - shift the current region right a 
  560.   tab
  561. Ñ sizeWin [win name] <width> <height> - sets size of current or specified window.
  562.   The window name can be "StatusWin", although only the width can be 
  563.   changed.
  564. Ñ sortMarks - sorts all marks of open windows, w/o 
  565.   setting the dirty flag. If the files are saved, the 
  566.   marks will be saved in alphabetical order.
  567. Ñ spacesToTabs - convert spaces in selection to tabs
  568. Ñ specToPathName [hex data] - given an FSSpec in hex form (as that 
  569.   returned by aebuild, for instance, see the definition of thinkFileName 
  570.   in :Tcl:SystemCode:think.tcl), return a complete pathname.
  571. Ñ splitWindow [percent] - toggle having window split into two panes. 
  572.   Optional arg specifies percent of window to allocate to the first pane. 
  573. Ñ startEscape - used to further modify the next 
  574.   keystroke combination, in the same manner as using the 
  575.   shift key in the next keystroke
  576. Ñ startKeyboardMacro - start recording keyboard macro
  577. Ñ statusPrompt <prompt> [<func>] - Prompt in the status window. If 'func' 
  578.   is present, call this routine at each key-press with the current 
  579.   contents of the status line and the key, insert into statusline 
  580.   whatever is returned by the func. Command-v pastes the current (<80 
  581.   char) clipboard contents on the status line.
  582. Ñ substituteVars <string> - Takes a single string and
  583.   substitutes for all variables inside it, regardless of
  584.   depth. Unfortunately, you currently need to make 'global var' 
  585.   declarations in the proc you call this for each 'var' that might need 
  586.   to be substituted in the string (see proc.tcl for examples).
  587. Ñ switchTo <appName> - Switches to application 'appName'.
  588. Ñ tab - insert a tab
  589. Ñ tabsToSpaces - convert tabs in selection to spaces.
  590. Ñ tclFileCompletion - completes the previous word as a
  591.   file is in a shell window
  592. Ñ tclResult - displays a dialog showing the result of 
  593.   the last TCL evaluation.
  594. Ñ thinkReference <-t|-l> <think reference page> - Interact with Think 
  595.   Reference 2.0. '-t' retrieves a template without leaving Alpha, '-l' 
  596.   switches to Think Reference and goes to the specified page.
  597. Ñ ticks
  598.   Returns the current TickCount. Ticks are 60ths of a seconds. TickCount is the 
  599.   number of ticks since the Macintosh was started. The command:
  600.         puts stdout [expr "[ticks] / 60"]
  601.   will print the number of seconds since the Macintosh was booted.
  602. Ñ toggleScrollbar - toggles horizontal scrollbar on frontmost window. 
  603.   Will not succeed if scrollbar scrolled.
  604. Ñ traceFunc on <funcName> <winName> Trace 'funcName', send output to 
  605.                                     'winName'. 
  606.   traceFunc off                        Turn function tracing off.
  607.   traceFunc status                    Display current tracing status.
  608. Ñ unascii  (see bindings)
  609. Ñ unbind  (see bindings)
  610. Ñ undo - undo the last action that has not been undone
  611. Ñ upcaseRegion - convert all lowercase letters to 
  612.   uppercase in the current region
  613. Ñ upcaseWord - convert all lowercase letters to 
  614.   uppercase in the current word
  615. Ñ version - Return string of the form "Alpha Version 5.31, Feb. 15, 1993".
  616. Ñ watchCursor - turns the cursor into a a watch cursor.
  617. Ñ wc <file>... - counts chars, words, lines of input files.
  618. Ñ winNames [-f] - return a TCL list of all open windows. If '-f' option 
  619.   specified, complete pathnames are returned.
  620. Ñ wrap - see the section on "Fill" routines.
  621. Ñ wrapText
  622. Ñ xtclcmd [-f filename] <cmdname> [argument_list]*
  623.   This command will load the external command cmdname and pass it the argument 
  624.   list [ cmdname argument_list... ]. External command are code resources of type 
  625.   XTCL. They may be located in the resource fork of the tickle application, or they 
  626.   may be located in a file named XTCL File in the same directory as the tickle 
  627.   application. If the optional -f filename is included, the external command will first 
  628.   be loaded from filename before the other two files.
  629.   See the appendix for a detailed description of the external tcl command interface. 
  630.   See the accompanying sources for an example of writing an XTCL.
  631. Ñ yank - insert the last piece of deleted text of less
  632.   than 1k. Consecutive deletes are concatenated.
  633.   together.
  634. Ñ zapInvisibles - removes chars < ascii 32, except for
  635.   LF's and CR's.
  636. Ñ zoom - zooms the current window
  637.